getBidsInfoForBusiness
Информация об установленных ставках
Возвращает значения ставок для заданных товаров. {% note warning "" %} В ответе возвращаются значения только тех ставок, которые вы установили через запрос [PUT businesses/{businessId}/bids](../../reference/bids/putBidsForBusiness.md). Получить информацию по кампаниям, созданным в кабинете, не получится. {% endnote %} В одном запросе может быть максимум 1500 товаров. |**⚙️ Лимит:** 1000 запросов в минуту| |-|
/businesses/{businessId}/bids/info
Usage and SDK Samples
curl -X POST \
\
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://api.partner.market.yandex.ru/businesses/{businessId}/bids/info?page_token=eyBuZXh0SWQ6IDIzNDIgfQ==&limit=20" \
-d '{
"skus" : [ null, null, null, null, null ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BidsApi;
import java.io.File;
import java.util.*;
public class BidsApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: OAuth
OAuth OAuth = (OAuth) defaultClient.getAuthentication("OAuth");
OAuth.setAccessToken("YOUR ACCESS TOKEN");
// Create an instance of the API class
BidsApi apiInstance = new BidsApi();
Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).
ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.
Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
Integer limit = 20; // Integer | Количество значений на одной странице.
GetBidsInfoRequest getBidsInfoRequest = ; // GetBidsInfoRequest |
try {
GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BidsApi#getBidsInfoForBusiness");
e.printStackTrace();
}
}
}
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final Long businessId = new Long(); // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).
ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
final String pageToken = new String(); // String | Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.
Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
final Integer limit = new Integer(); // Integer | Количество значений на одной странице.
final GetBidsInfoRequest getBidsInfoRequest = new GetBidsInfoRequest(); // GetBidsInfoRequest |
try {
final result = await api_instance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
print(result);
} catch (e) {
print('Exception when calling DefaultApi->getBidsInfoForBusiness: $e\n');
}
import org.openapitools.client.api.BidsApi;
public class BidsApiExample {
public static void main(String[] args) {
BidsApi apiInstance = new BidsApi();
Long businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).
ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
String pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.
Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
Integer limit = 20; // Integer | Количество значений на одной странице.
GetBidsInfoRequest getBidsInfoRequest = ; // GetBidsInfoRequest |
try {
GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BidsApi#getBidsInfoForBusiness");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Create an instance of the API class
BidsApi *apiInstance = [[BidsApi alloc] init];
Long *businessId = 789; // Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).
ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
(default to null)
String *pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.
Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
(optional) (default to null)
Integer *limit = 20; // Количество значений на одной странице.
(optional) (default to null)
GetBidsInfoRequest *getBidsInfoRequest = ; // (optional)
// Информация об установленных ставках
[apiInstance getBidsInfoForBusinessWith:businessId
pageToken:pageToken
limit:limit
getBidsInfoRequest:getBidsInfoRequest
completionHandler: ^(GetBidsInfoResponse output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var Api = require('_api_');
var defaultClient = Api.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth
var OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = "YOUR ACCESS TOKEN";
// Create an instance of the API class
var api = new Api.BidsApi()
var businessId = 789; // {Long} Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).
ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
var opts = {
'pageToken': eyBuZXh0SWQ6IDIzNDIgfQ==, // {String} Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.
Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
'limit': 20, // {Integer} Количество значений на одной странице.
'getBidsInfoRequest': // {GetBidsInfoRequest}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getBidsInfoForBusiness(businessId, opts, callback);
using System;
using System.Diagnostics;
using ympa_html2_doc.Api;
using ympa_html2_doc.Client;
using ympa_html2_doc.Model;
namespace Example
{
public class getBidsInfoForBusinessExample
{
public void main()
{
// Configure OAuth2 access token for authorization: OAuth
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
// Create an instance of the API class
var apiInstance = new BidsApi();
var businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).
ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
(default to null)
var pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.
Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
(optional) (default to null)
var limit = 20; // Integer | Количество значений на одной странице.
(optional) (default to null)
var getBidsInfoRequest = new GetBidsInfoRequest(); // GetBidsInfoRequest | (optional)
try {
// Информация об установленных ставках
GetBidsInfoResponse result = apiInstance.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling BidsApi.getBidsInfoForBusiness: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: OAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BidsApi();
$businessId = 789; // Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).
ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String | Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.
Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
$limit = 20; // Integer | Количество значений на одной странице.
$getBidsInfoRequest = ; // GetBidsInfoRequest |
try {
$result = $api_instance->getBidsInfoForBusiness($businessId, $pageToken, $limit, $getBidsInfoRequest);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BidsApi->getBidsInfoForBusiness: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BidsApi;
# Configure OAuth2 access token for authorization: OAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BidsApi->new();
my $businessId = 789; # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).
ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
my $pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; # String | Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.
Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
my $limit = 20; # Integer | Количество значений на одной странице.
my $getBidsInfoRequest = WWW::OPenAPIClient::Object::GetBidsInfoRequest->new(); # GetBidsInfoRequest |
eval {
my $result = $api_instance->getBidsInfoForBusiness(businessId => $businessId, pageToken => $pageToken, limit => $limit, getBidsInfoRequest => $getBidsInfoRequest);
print Dumper($result);
};
if ($@) {
warn "Exception when calling BidsApi->getBidsInfoForBusiness: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Create an instance of the API class
api_instance = openapi_client.BidsApi()
businessId = 789 # Long | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).
ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
(default to null)
pageToken = eyBuZXh0SWQ6IDIzNDIgfQ== # String | Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.
Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
(optional) (default to null)
limit = 20 # Integer | Количество значений на одной странице.
(optional) (default to null)
getBidsInfoRequest = # GetBidsInfoRequest | (optional)
try:
# Информация об установленных ставках
api_response = api_instance.get_bids_info_for_business(businessId, pageToken=pageToken, limit=limit, getBidsInfoRequest=getBidsInfoRequest)
pprint(api_response)
except ApiException as e:
print("Exception when calling BidsApi->getBidsInfoForBusiness: %s\n" % e)
extern crate BidsApi;
pub fn main() {
let businessId = 789; // Long
let pageToken = eyBuZXh0SWQ6IDIzNDIgfQ==; // String
let limit = 20; // Integer
let getBidsInfoRequest = ; // GetBidsInfoRequest
let mut context = BidsApi::Context::default();
let result = client.getBidsInfoForBusiness(businessId, pageToken, limit, getBidsInfoRequest, &context).wait();
println!("{:?}", result);
}
Scopes
| market:partner-api | API Яндекс.Маркета / Поиска по товарам для партнеров |
Parameters
| Name | Description |
|---|---|
| businessId* |
Long
(int64)
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).
ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
Required
|
| Name | Description |
|---|---|
| getBidsInfoRequest |
description |
| Name | Description |
|---|---|
| page_token |
String
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.
Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
|
| limit |
Integer
(int32)
Количество значений на одной странице.
|